package org.wak.inventory
{
	import flash.display.DisplayObject;
	
	/**
	 * Interface to hold the data to create and inventory definition. 
	 * 
	 */	
	public interface IInventoryItemDefinition
	{
		/**
		 * The item id of this item 
		 * @return String with the item id.
		 * 
		 */		
		function get itemId():String
		
		/**
		 * The item textual name of this item 
		 * @return String with a textual name for the item.
		 * 
		 */		
		function get itemName():String
		
		
		/**
		 * The graphic id to show while this item is in the inventory 
		 * @return a String with the item image id.
		 */		
		function get itemDisplayId():String ;
		
		/**
		 * This is the icon id to display when the Use action has been 
		 * selected and used with the item. The mouseIconDisplay will be attached
		 * to the mouse pointer. 
		 * @return A String with the mouse pointer item icon id.
		 * 
		 */		
		function get mouseIconDisplayId():String ;
		
		/**
		 * Mouse icon horizontal offset about the mouse pointer. 
		 * @return x coordinate of the mouse Icon Display.
		 * 
		 */		
		function get mouseIconX():Number ;
		
		/**
		 * Mouse icon verticall offset about the mouse pointer. 
		 * @return y coordinate of the mouse Icon Display.
		 * 
		 */	
		function get mouseIconY():Number ;
		
		/**
		 *  
		 * @return true to set this item for unitary use with the Use action 
		 * 
		 */		
		function get unitaryUse():Boolean ;
		
		/**
		 * Description of the item 
		 * @return String with description
		 * 
		 */		
		function get description():String ;
		
		
	}
}